home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 015a / pauxip.zip / PAUZ.DOC next >
Text File  |  1991-03-27  |  5KB  |  143 lines
  1.                                PAUZ 2.0
  2.  
  3.                Specifiable wait function for batch files
  4.  
  5.                                   by
  6.                                Bob Eyer
  7.                              Mar 27, 1991
  8.  
  9.  
  10.      Syntax
  11.      ------
  12.      PAUZ ResumeChar [WaitSeconds|TargetTime]
  13.  
  14.      Definitions
  15.      -----------
  16.      ResumeChar:     The upper or lower case character  the  user  must
  17.                      press  to continue processing before PAUZ finishes
  18.                      waiting.  PAUZ's interpretation of  ResumeChar  is
  19.                      not case sensitive.
  20.  
  21.                      If  SPACE is entered for ResumeChar, PAUZ will use
  22.                      the Spacebar as  the  key  to  hit  for  continued
  23.                      processing.  If ANY is used then PAUZ uses any key
  24.                      for this purpose.
  25.  
  26.      Second parameter (optional):
  27.      Either -
  28.      WaitSeconds:    The  maximum  number  of  seconds  PAUZ will delay
  29.                      processing.
  30.      or -
  31.      TargetTime:     The time  in  HH:MM  format  at  which  PAUZ  will
  32.                      continue   processing.   This  parameter  must  be
  33.                      entered with a colon,  in  formats  like  8:40  or
  34.                      08:40.   Postmeridian  times  must  be  entered in
  35.                      24-hour format.
  36.  
  37.      Where  the second parameter is not mentioned, PAUZ will operate in
  38.      wait rather than target mode, using defaults as discussed below in
  39.      the section entitled "WaitSeconds Defaults".
  40.  
  41.      Discussion
  42.      ----------
  43.      PAUZ  i/o  is redirectable.  So, PAUZ can be used to assist design
  44.      of batch file-based remote door programs.
  45.  
  46.      New:
  47.      PAUZ 2.0 adds pickup of number keys during a PAUZ wait, to  resume
  48.      processing  by  returning  an  error level identical to the number
  49.      selected.
  50.  
  51.      Examples
  52.      --------
  53.      The  following  shows  how  to  use PAUZ with the program's return
  54.      message:
  55.  
  56.      (1)
  57.      PAUZ ANY
  58.      Press any key or wait 30 seconds to continue ...
  59.  
  60.      Pressing  any  key  will return control to DOS (or the batch file)
  61.      with  error  level  1;   otherwise,   control   will   be   passed
  62.      automatically  with  error  level  0 if no key is pressed after 30
  63.      seconds have elapsed.
  64.  
  65.      (2)
  66.      PAUZ SPACE
  67.      Press [SPACEBAR] or wait 30 seconds to continue ...
  68.  
  69.      (3)
  70.      PAUZ A
  71.      Press [A] or wait 15 seconds to continue ...
  72.  
  73.      (4)
  74.      PAUZ A 75
  75.      Press [A] or wait 75 seconds to continue ...
  76.  
  77.      Note  the  effect  of  overriding  the 15 second default for the A
  78.      ResumeChar (see below).
  79.  
  80.      (5)
  81.      PAUZ A 14:20
  82.      Press [A] or wait until 14:20 to continue ...
  83.  
  84.      Notice that the use of a target time  causes  PAUZ  to  alter  the
  85.      format of its wait message.
  86.  
  87.      Note:
  88.      In  any of these examples, PAUZ will resume with error level x, if
  89.      a key in the range  1  to  9  is  pressed.   The  error  level  is
  90.      identical to the number of the key selected.
  91.  
  92.      This is useful in using PAUZ to provide  for  branching  logic  in
  93.      batch file programs.
  94.  
  95.      WaitSeconds Defaults
  96.      --------------------
  97.      In  the event the user does not mention WaitSeconds on the command
  98.      line, PAUZ uses  the  identity  of  ResumeChar  to  determine  the
  99.      magnitude of the maximum wait time.  The following table indicates
  100.      the defaults supported:
  101.  
  102.             ResumeChar         Default Wait Time
  103.  
  104.                  A               15 seconds
  105.  
  106.                  B               60
  107.  
  108.                  C              120
  109.  
  110.                  D              240
  111.  
  112.      Anything  used  for ResumeChar other than A, B, C, or D will cause
  113.      PAUZ to use 30 seconds as the default wait time.
  114.  
  115.      Of course, in the event the user does mention WaitSeconds  on  the
  116.      command  line,  the  user's  wait  time will always override these
  117.      defaults.
  118.  
  119.      Error Levels
  120.      ------------
  121.      PAUZ's normal termination is  defined  as  an  uninterrupted  PAUZ
  122.      run  -  i.e.   without touching any ResumeChar key.  In this case,
  123.      PAUZ returns an error level of 0.
  124.  
  125.      If the user interrupts PAUZ processing  by  hitting  the  required
  126.      ResumeChar, then PAUZ returns an error level of 1.
  127.  
  128.      DISCLAIMER:
  129.      ==========
  130.      This  program  is  circulated as freeware without any guarantee or
  131.      warranty; and the  user,  by  downloading  this  program,  or  any
  132.      variant  thereof  or by receiving it or any of its versions in any
  133.      other form, agrees to accept full responsibility for its use.   It
  134.      is  therefore understood that the user accepts this program or any
  135.      previous version as is.
  136.  
  137.      Bob Eyer                  The author may also be reached at
  138.      Compuserve [73230,2620]   ROSE MEDIA 416-733-2285 (Main Conf)
  139.      Toronto                   or
  140.      Canada                    CANADA REMOTE 416-629-7044 (IBM Conf)
  141.      -------------------------------------------------------------
  142.      End of documentation
  143.